<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>usbps: XUsbPs Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">usbps
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_usb_ps.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XUsbPs Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="struct_x_usb_ps.html" title="The XUsbPs driver instance data. ">XUsbPs</a> driver instance data.  
 <a href="struct_x_usb_ps.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a85f47a2007b61d22d85cc229a7afe26b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_usb_ps___config.html">XUsbPs_Config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_usb_ps.html#a85f47a2007b61d22d85cc229a7afe26b">Config</a></td></tr>
<tr class="memdesc:a85f47a2007b61d22d85cc229a7afe26b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration structure.  <a href="#a85f47a2007b61d22d85cc229a7afe26b">More...</a><br /></td></tr>
<tr class="separator:a85f47a2007b61d22d85cc229a7afe26b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80882eb961ff042c499032cce8213eb6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_usb_ps.html#a80882eb961ff042c499032cce8213eb6">CurrentAltSetting</a></td></tr>
<tr class="memdesc:a80882eb961ff042c499032cce8213eb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current alternative setting of interface.  <a href="#a80882eb961ff042c499032cce8213eb6">More...</a><br /></td></tr>
<tr class="separator:a80882eb961ff042c499032cce8213eb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d724c9ee59aaa42d0a2f6d467de698c"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_usb_ps.html#a2d724c9ee59aaa42d0a2f6d467de698c">UserDataPtr</a></td></tr>
<tr class="memdesc:a2d724c9ee59aaa42d0a2f6d467de698c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data pointer to be used by upper layers to store application dependent data structures.  <a href="#a2d724c9ee59aaa42d0a2f6d467de698c">More...</a><br /></td></tr>
<tr class="separator:a2d724c9ee59aaa42d0a2f6d467de698c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b2850e98dd08df31ee5369ce56e8c50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_usb_ps___device_config.html">XUsbPs_DeviceConfig</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_usb_ps.html#a6b2850e98dd08df31ee5369ce56e8c50">DeviceConfig</a></td></tr>
<tr class="memdesc:a6b2850e98dd08df31ee5369ce56e8c50"><td class="mdescLeft">&#160;</td><td class="mdescRight">The following structures hold the configuration for DEVICE mode of the controller.  <a href="#a6b2850e98dd08df31ee5369ce56e8c50">More...</a><br /></td></tr>
<tr class="separator:a6b2850e98dd08df31ee5369ce56e8c50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdcf162fbc8bd0b2e4eb32386bdb22d8"><td class="memItemLeft" align="right" valign="top">XUsbPs_IntrHandlerFunc&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_usb_ps.html#acdcf162fbc8bd0b2e4eb32386bdb22d8">HandlerFunc</a></td></tr>
<tr class="memdesc:acdcf162fbc8bd0b2e4eb32386bdb22d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler function for the controller.  <a href="#acdcf162fbc8bd0b2e4eb32386bdb22d8">More...</a><br /></td></tr>
<tr class="separator:acdcf162fbc8bd0b2e4eb32386bdb22d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ff9fb5a7e23901d72230e26dfc9ae5d"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_usb_ps.html#a5ff9fb5a7e23901d72230e26dfc9ae5d">HandlerRef</a></td></tr>
<tr class="memdesc:a5ff9fb5a7e23901d72230e26dfc9ae5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data reference for the handler.  <a href="#a5ff9fb5a7e23901d72230e26dfc9ae5d">More...</a><br /></td></tr>
<tr class="separator:a5ff9fb5a7e23901d72230e26dfc9ae5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82d001c64fb44301908797ffae28abd0"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_usb_ps.html#a82d001c64fb44301908797ffae28abd0">HandlerMask</a></td></tr>
<tr class="memdesc:a82d001c64fb44301908797ffae28abd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">User interrupt mask.  <a href="#a82d001c64fb44301908797ffae28abd0">More...</a><br /></td></tr>
<tr class="separator:a82d001c64fb44301908797ffae28abd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="struct_x_usb_ps.html" title="The XUsbPs driver instance data. ">XUsbPs</a> driver instance data. </p>
<p>The user is required to allocate a variable of this type for every USB controller in the system. A pointer to a variable of this type is then passed to the driver API functions. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a85f47a2007b61d22d85cc229a7afe26b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85f47a2007b61d22d85cc229a7afe26b">&#9670;&nbsp;</a></span>Config</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_usb_ps___config.html">XUsbPs_Config</a> XUsbPs::Config</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configuration structure. </p>

<p class="reference">Referenced by <a class="el" href="group__usbps__v2__2.html#ga1a3417695facf9eff86ce6a1e14a9bbc">XUsbPs_CfgInitialize()</a>, <a class="el" href="group__usbps__v2__2.html#ga69b214c21727c4b1f641d84414f397df">XUsbPs_DeviceReset()</a>, <a class="el" href="group__usbps__v2__2.html#gaba0ae2eac9c6b402e32e401333a5b105">XUsbPs_EpPrime()</a>, <a class="el" href="group__usbps__v2__2.html#ga60e2b0f6fabc24cdf785d704ab2585d1">XUsbPs_IntrHandler()</a>, <a class="el" href="group__usbps__v2__2.html#ga2c583a4c515653fd70c111fe0d2ddb37">XUsbPs_Reset()</a>, and <a class="el" href="group__usbps__v2__2.html#ga8c700bcf9ba08271914145803776d265">XUsbPs_SetDeviceAddress()</a>.</p>

</div>
</div>
<a id="a80882eb961ff042c499032cce8213eb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80882eb961ff042c499032cce8213eb6">&#9670;&nbsp;</a></span>CurrentAltSetting</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XUsbPs::CurrentAltSetting</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Current alternative setting of interface. </p>

<p class="reference">Referenced by <a class="el" href="group__usbps__v2__2.html#ga1a3417695facf9eff86ce6a1e14a9bbc">XUsbPs_CfgInitialize()</a>.</p>

</div>
</div>
<a id="a6b2850e98dd08df31ee5369ce56e8c50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b2850e98dd08df31ee5369ce56e8c50">&#9670;&nbsp;</a></span>DeviceConfig</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_usb_ps___device_config.html">XUsbPs_DeviceConfig</a> XUsbPs::DeviceConfig</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The following structures hold the configuration for DEVICE mode of the controller. </p>
<p>They are initialized using the <a class="el" href="group__usbps__v2__2.html#ga6daace32113a806a6822a6d5943a93f4" title="This function configures the DEVICE side of the controller. ">XUsbPs_ConfigureDevice()</a> function call.Configuration for the DEVICE mode. </p>

<p class="reference">Referenced by <a class="el" href="group__usbps__v2__2.html#ga6daace32113a806a6822a6d5943a93f4">XUsbPs_ConfigureDevice()</a>, <a class="el" href="group__usbps__v2__2.html#gac27a9d64ddf33a2400d7493e301a7192">XUsbPs_EpBufferReceive()</a>, <a class="el" href="group__usbps__v2__2.html#ga1e4c0735be24ea24b73404db8d18133e">XUsbPs_EpBufferSendWithZLT()</a>, and <a class="el" href="group__usbps__v2__2.html#ga91c44ff9dcae2e47ed8112c8a0779fa1">XUsbPs_EpGetSetupData()</a>.</p>

</div>
</div>
<a id="acdcf162fbc8bd0b2e4eb32386bdb22d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdcf162fbc8bd0b2e4eb32386bdb22d8">&#9670;&nbsp;</a></span>HandlerFunc</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XUsbPs_IntrHandlerFunc XUsbPs::HandlerFunc</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Handler function for the controller. </p>

<p class="reference">Referenced by <a class="el" href="group__usbps__v2__2.html#ga1a3417695facf9eff86ce6a1e14a9bbc">XUsbPs_CfgInitialize()</a>.</p>

</div>
</div>
<a id="a82d001c64fb44301908797ffae28abd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82d001c64fb44301908797ffae28abd0">&#9670;&nbsp;</a></span>HandlerMask</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XUsbPs::HandlerMask</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>User interrupt mask. </p>
<p>Defines which interrupts will cause the callback to be called. </p>

</div>
</div>
<a id="a5ff9fb5a7e23901d72230e26dfc9ae5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ff9fb5a7e23901d72230e26dfc9ae5d">&#9670;&nbsp;</a></span>HandlerRef</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XUsbPs::HandlerRef</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>User data reference for the handler. </p>

</div>
</div>
<a id="a2d724c9ee59aaa42d0a2f6d467de698c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d724c9ee59aaa42d0a2f6d467de698c">&#9670;&nbsp;</a></span>UserDataPtr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XUsbPs::UserDataPtr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Data pointer to be used by upper layers to store application dependent data structures. </p>
<p>The upper layers are responsible to allocated and free the memory. The driver will not mofidy this data pointer. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
